pike > FinScribe > Documentation > Wiki Markup

Wiki Markup

Created by hww3. Last updated by hww3, 13 years ago. Version #12.

Markup

The Wiki markup engine used by FinScribe turns text that contains simple markup into fully formatted HTML. The markup consists of the symbols added to the text you type that tells the FinScribe wiki engine to format the relevant text in a particular way. These markup commands make it simple to generate richly formatted pages without having to learn complicated codes or language.

Markup	Result	Description
1 Title	Title	a style 1 heading (major heading)
1.1 Title	Title	a style 1.1 heading (minor heading)
- text	text	a list item (with -), several lines create a single list
* text	text	a list item (with *)
1. text	text	an enumerated list
a. text	text	alphabetical enumerated list
A. text	text	uppercase alphabetical enumerated list
i. text	text	roman enumerated list
I. text	text	uppercase roman enumerated list
g. text	text	greek enumerated list
h. text	text	hiragana (japanese) enumerated list
k. text	text	katakana (japanese) enumerated list
__bold__	bold	simple bold text
~~italics~~	italics	simple italic text
{{monospace}}	monospace	monospace text
??citation??	citation	citation
--strike--	strike	strike through text
+underscore+	underscore	underline (editing/insertion mark) text
^superscript^	superscript	superscript
~subscript~	subscript	subscript
(empty line)		produces a new paragraph
\\		creates a line break, please use sparingly!
[start]	start	internal link to another document
http://apple.com/	http://apple.com	creates a link to an external resource, special characters that come after the URL and are not part of it must be separated with a space.
\X	{	escape special character X (i.e. {)
Ctrl or Alt or Shift or Cmd or Meta or Option-X	Ctrl-C	Describe a keystroke, rendering varies based on theme.
-- (2 hyphens)	--	insert an en-dash
--- (3 hyphens)	---	insert an em-dash
---- (4+ hyphens)		creates a horizontal rule

Macros

FinScribe includes a number of macros, which are split into a set of core macros that are always available, as well as macros provided by various plugins, which may be enabled by a system administrator on a case-by-case basis.

Macros enable a page author to add extra functionality or include dynamic content on a page. Each macro has a name that's used to identify it and a given macro is specified in a page by surrounding its name by curly braces. For example:

Containers

Each macro may take one or more arguments that control the way the macro works, and may also take a piece of content to operate on, in which case we call that macro a "container". A macro that is a container consists of a matching pair of {macro} tags with the content in between.

For example:

Arguments

A macro that takes arguments specifies its arguments by passing them after the macro name, separated from the macro name by a colon. Multiple arguments are separated from each other by a "pipe" symbol (|). Note that there should not be any spaces between any of the elements in a macro definition. For example:

Macros in HTML content

Macros are also available in FinScribe pages that use HTML format, as well. Each macro is available in HTML format as a tag or container with the same name as the macro. Arguments are passed as attributes to the tag or container in the standard HTML fashion.

For example:

or

Examples

An example of a macro that doesn't take any arguments:

In HTML Mode:

An example of a macro that takes a few arguments:

In HTML Mode:

An example of a container macro that doesn't require arguments:

In HTML mode:

An example of a container macro that takes arguments:

In HTML Mode:

Available Macros

The following table lists all of the wiki macros bundled in these two categories and lists the plugin that provides each macro.

Macro	Plugin	Container	Description
table	core	Y
link	core	N
hello	core	N
break	core	N
code	core	Y
quote	core	Y
boggle	core
api	core
macro-list	core	N
image	core
weblog	core	N
object-index	core	N
attachment-index	core	N
category-index	core	N
category-output	core
subpage-output	core
deck	core	Y
page	core	Y
card	core	Y
folder	core	Y
warning	core	Y
note	core	Y
info	core	Y
tip	core	Y
include	core	N
album	album
category-cloud	category_cloud	N
search-dialog	fulltext	N
search-results	fulltext	N
gravatar	gravatar	N
recent-changes	recent_changes	N
rss-reader	rss_reader	N
rss-output	rss_reader	Y

Link Macro

{link:url|target|img=no}

where target is the (optional) text containing the link, url is the linked url and img is an optional argument that disables the "external link" icon that appears next to each link.

Not categorized | RSS Feed | BackLinks